Skip to content

docs: enhance campaign orchestrator/worker architecture and add roadmap view guidance#6938

Merged
mnkiefer merged 2 commits intomainfrom
copilot/update-campaign-documentation
Dec 19, 2025
Merged

docs: enhance campaign orchestrator/worker architecture and add roadmap view guidance#6938
mnkiefer merged 2 commits intomainfrom
copilot/update-campaign-documentation

Conversation

Copy link
Contributor

Copilot AI commented Dec 19, 2025 •
edited
Loading

The campaign documentation lacked detailed explanation of the orchestrator/worker coordination model and didn't document how to use GitHub Projects roadmap views with custom date fields.

Orchestrator/Worker Architecture

Expanded the coordination section with three new subsections:

  • The Coordination Pattern - Clarifies tracker-id mechanism for discovery
  • Orchestrator Workflow Phases - Documents the four-phase execution model (Read State → Make Decisions → Write State → Report)
  • Core Design Principles - Explains immutability, campaign-agnostic workers, external logic, single source of truth, and idempotency guarantees

Project Roadmap Views with Custom Date Fields

Added new section documenting how to use GitHub Projects roadmap views for timeline visualization:

  • Setup process - Creating Start Date and End Date fields in Projects UI
  • Orchestrator configuration - Setting date fields automatically via fields parameter:
update-project:
  project: "https://github.com/orgs/myorg/projects/42"
  item_url: "https://github.com/myorg/myrepo/issues/123"
  fields:
    status: "In Progress"
    start_date: "2025-12-19"
    end_date: "2025-12-26"
  • Best practices - Field naming conventions, date assignment strategies for different work states, roadmap view benefits
  • Example workflow - Complete campaign showing date field calculation based on issue size
  • Limitations - Manual field creation requirement, case-sensitive naming, ISO 8601 date format, no auto-recalculation

Additional Changes

  • Added custom date fields to "Recommended default wiring" list as optional primitive for timeline visualization

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/24.12.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

Uodate campaign documentation to explain how it works now (orchestrator/workers) and consider adding custom fields to worked project items that define start and end date/time so we can make use of the project roadmap view.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@mnkiefer
docs: enhance campaign documentation with orchestrator/worker archite…
43f8f48 
…cture and roadmap view support

- Expanded orchestrator/worker coordination section with four-phase workflow model
- Added core design principles explaining separation of concerns
- Added comprehensive section on using custom date fields for GitHub Projects roadmap views
- Documented setup process for Start Date and End Date fields
- Provided examples of orchestrator configurations that set date fields automatically
- Included best practices for date field naming and assignment strategies
- Added example campaign with roadmap tracking workflow
- Listed limitations and considerations for custom field usage

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Update campaign documentation for orchestrator and workers docs: enhance campaign orchestrator/worker architecture and add roadmap view guidance Dec 19, 2025
Copilot AI requested a review from mnkiefer December 19, 2025 11:40
@mnkiefer mnkiefer marked this pull request as ready for review December 19, 2025 11:44
@mnkiefer mnkiefer merged commit 786c5dc into main Dec 19, 2025
91 checks passed
@mnkiefer mnkiefer deleted the copilot/update-campaign-documentation branch December 19, 2025 11:51
This was referenced Dec 19, 2025
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@mnkiefer mnkiefer mnkiefer approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@mnkiefer mnkiefer

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mnkiefer